Convert man page to Docbook

This make it easier to update the content and to transform
the man page into other output formats, like HTML.

https://bugzilla.gnome.org/show_bug.cgi?id=680601

diff --git a/configure.ac b/configure.ac
index eeed23657be2e6666515172e0f9fe9ded7ae48f1..ffe9172244c1497bea7e96b3bfb52859a177012d 100644 (file)
--- a/configure.ac
+++ b/configure.ac
@@ -36,6 +36,8 @@ AC_DEFINE_UNQUOTED(GETTEXT_PACKAGE, "$GETTEXT_PACKAGE",
 
 PKG_PROG_PKG_CONFIG([0.22])
 
+AC_PATH_PROG([XSLTPROC], [xsltproc])
+
 GLIB_GSETTINGS
 
 # Get a value to substitute into gnome-shell.in

diff --git a/man/Makefile.am b/man/Makefile.am
index c4f139f49444819c3a3acbf4f099c9304abda531..510e9c66c855b001f19c732d24924012e0afbcc1 100644 (file)
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -1 +1,11 @@
-dist_man_MANS = gnome-shell.1
+.xml.1:
+       $(AM_V_GEN) $(XSLTPROC) -o $@ --nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
+
+man_MANS = \
+       gnome-shell.1
+
+xml_files = $(man_MANS:.1=.xml)
+
+EXTRA_DIST = $(xml_files)
+
+DISTCLEANFILES = $(man_MANS)

diff --git a/man/gnome-shell.1 b/man/gnome-shell.1
deleted file mode 100644 (file)
index 957902d..0000000
--- a/man/gnome-shell.1
+++ /dev/null
@@ -1,94 +0,0 @@
-.\" Copyright (c) 2009, Marcelo Jorge Vieira (metal) <metal@alucinados.com>
-.\"
-.\" This is free documentation; you can redistribute it and/or
-.\" modify it under the terms of the GNU General Public License as
-.\" published by the Free Software Foundation; either version 2 of
-.\" the License, or (at your option) any later version.
-.\"
-.\" The GNU General Public License's references to "object code"
-.\" and "executables" are to be interpreted as the output of any
-.\" document formatting or typesetting system, including
-.\" intermediate and printed output.
-.\"
-.\" This manual is distributed in the hope that it will be useful,
-.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
-.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-.\" GNU General Public License for more details.
-.\"
-.\" You should have received a copy of the GNU General Public
-.\" License along with this manual; if not, write to the Free
-.\" Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
-.\" Boston, MA  02111-1301  USA.
-.TH GNOME-SHELL 1
-.SH NAME
-gnome-shell \- Graphical shell for the GNOME desktop
-
-.SH SYNOPSIS
-.B gnome-shell [options]
-
-.SH DESCRIPTION
-GNOME Shell provides core user interface functions for the GNOME 3
-desktop, like switching to windows and launching applications. GNOME
-Shell takes advantage of the capabilities of modern graphics hardware
-and introduces innovative user interface concepts to provide a
-visually attractive and easy to use experience.
-
-.SH OPTIONS
-
-.TP
-.B \-\-replace
-Replace the running window manager
-.br
-
-.TP
-.B \-\-sm-disable
-Disable connection to the session manager
-.br
-
-.TP
-.B \-\-sm-client-id=ID
-Specify session management ID
-.br
-
-.TP
-.B \-\-sm-save-file=FILE
-Initialize session from savefile
-.br
-
-.TP
-.B \-\-screen=SCREEN
-X screen to use
-.br
-
-.TP
-.B \-d, \-\-display=DISPLAY
-X display to use
-.br
-
-.TP
-.B \-\-sync
-Make X calls synchronous
-.br
-
-.TP
-.B \-\-version
-Print version and exit
-.br
-
-.TP
-.B \-\-help
-Display help and exit
-.br
-
-.SH BUGS
-The bug tracker can be reached by visiting the website
-\fIhttps://bugzilla.gnome.org/buglist.cgi?product=gnome-shell\fR
-
-Before sending a bug report, please verify that you have the latest
-version of gnome-shell. Many bugs (major and minor) are fixed at each
-release, and if yours is out of date, the problem may already have
-been solved.
-
-.SH ADDITIONAL INFORMATION
-
-For further information, visit the website \fIhttp://live.gnome.org/GnomeShell\fR

diff --git a/man/gnome-shell.xml b/man/gnome-shell.xml
new file mode 100644 (file)
index 0000000..7e43536
--- /dev/null
+++ b/man/gnome-shell.xml
@@ -0,0 +1,132 @@
+<?xml version='1.0'?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+
+<refentry id="gnome-shell">
+
+        <refentryinfo>
+                <title>gnome-shell</title>
+                <productname>gnome-shell</productname>
+
+                <authorgroup>
+                        <author>
+                                <contrib>wrote the original gnome-shell man page</contrib>
+                                <firstname>Marcelo Jorge</firstname>
+                                <surname>Vieira</surname>
+                                <email>metal@alucinados.com</email>
+                        </author>
+                </authorgroup>
+
+        </refentryinfo>
+
+        <refmeta>
+                <refentrytitle>gnome-shell</refentrytitle>
+                <manvolnum>1</manvolnum>
+        </refmeta>
+
+        <refnamediv>
+                <refname>gnome-shell</refname>
+                <refpurpose>Graphical shell for the GNOME desktop</refpurpose>
+        </refnamediv>
+
+        <refsynopsisdiv>
+                <cmdsynopsis>
+                        <command>gnome-shell <arg choice="opt" rep="repeat">OPTION</arg></command>
+                </cmdsynopsis>
+        </refsynopsisdiv>
+
+        <refsect1>
+                <title>Description</title>
+
+                <para>GNOME shell provides core user
+                interface functions for the GNOME 3 desktop, like switching
+                to windows and launching applications. GNOME shell takes
+                advantage of the capabilities of modern graphics hardware
+                and introduces innovative user interface concepts to provide
+                a visually attractive and easy to use experience.</para>
+
+        </refsect1>
+
+        <refsect1>
+                <title>Options</title>
+
+                <variablelist>
+
+                        <varlistentry>
+                                <term><option>--replace</option></term>
+
+                                <listitem><para>Replace the running window manager</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--sm-disable</option></term>
+
+                                <listitem><para>Disable connection to the session manager</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--sm-client-id=<replaceable>ID</replaceable></option></term>
+
+                                <listitem><para>Specify session management <replaceable>ID</replaceable></para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--sm-save-file=<replaceable>FILE</replaceable></option></term>
+
+                                <listitem><para>Initialize session from <replaceable>FILE</replaceable></para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--screen=<replaceable>SCREEN</replaceable></option></term>
+
+                                <listitem><para>X screen to use</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>-d</option>, <option>--display=<replaceable>DISPLAY</replaceable></option></term>
+
+                                <listitem><para>X Display to use</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--sync</option></term>
+
+                                <listitem><para>Make X calls synchronous</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--version</option></term>
+
+                                <listitem><para>Print version and exit</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--help</option></term>
+
+                                <listitem><para>Display help and exit</para></listitem>
+                        </varlistentry>
+
+                </variablelist>
+
+        </refsect1>
+
+        <refsect1>
+                <title>Bugs</title>
+
+                <para>The bug tracker can be reached by visiting the
+                website <ulink url="https://bugzilla.gnome.org/buglist.cgi?product=gnome-shell">https://bugzilla.gnome.org/buglist.cgi?product=gnome-shell</ulink>.
+                Before sending a bug report, please verify that you have
+                the latest version of gnome-shell. Many bugs (major and
+                minor) are fixed at each release, and if yours is out of
+                date, the problem may already have been solved.</para>
+
+        </refsect1>
+
+        <refsect1>
+                <title>Additional Information</title>
+
+                <para>For further information, visit the website
+                <ulink url="http://live.gnome.org/GnomeShell">http://live.gnome.org/GnomeShell</ulink>.</para>
+        </refsect1>
+
+</refentry>